Interface Pool

All Superinterfaces:
IPCObject
All Known Subinterfaces:
IPPool, NumberPool, StringPool
All Known Implementing Classes:
IPPoolImpl, NumberPoolImpl, PoolImpl, StringPoolImpl

public interface Pool extends IPCObject
Information provided by the PKI file:

    \class Pool
    
    \brief Pool is the base class for all variable pools for activities.
    
    \example appWindow().getActiveFile().getVariableManager().getIpPoolAt(0)
    
Author:
Auto-generated
  • Method Details

    • name

      String name()
      Information provided by the PKI file:
      
          \brief Returns the name of the pool.
          
          \return QString, the name of the pool.
          
              
      Returns:
      String Returns a String
    • getElementToString

      String getElementToString(int index)
      Information provided by the PKI file:
      
          \brief Returns the element in the pool at the specified index.
          
          \param index, the index of the element in the pool of interest.
          
          \return QString, the element in the pool at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • isInPool

      boolean isInPool(String value)
      Information provided by the PKI file:
      
          \brief Returns true if the specified value is in the pool, otherwise false.
          
          \param value, value to find in the pool.
          
          \return bool, true if the specified value is in the pool, otherwise false.
          
              
      Parameters:
      value - Takes in a parameter of value
      Returns:
      boolean Returns a boolean